Repository navigation
chore(lint): enforce Docusaurus Link and Heading with ESLint - #4830
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
ShaneK
approved these changes
Nov 5, 2026
ShaneK
left a comment
ShaneK
left a comment
Member
There was a problem hiding this comment.
Looks good to me, great work! 🚀
# Conflicts: # .gitignore # package.json
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue URL: internal
What is the current behavior?
A raw
<a>to a page that doesn't exist builds without errors. The build only checks links and anchors that go through Markdown or the DocusaurusLinkandHeadingcomponents, and nothing stops a raw<a>or<h1>to<h6>from coming back now that #4825 converted them.What is the new behavior?
npm run eslintruns the two rules Docusaurus ships for this,@docusaurus/no-html-linksand@docusaurus/prefer-docusaurus-heading, onsrc/and the 478 hand-written.mdxpages indocs/and every version inversions.jsonChecksjobnpm run eslintuses--cache, so a repeat local run takes 0.4s instead of 5s..eslintcacheis gitignoredstatic/are not linted. Generatednative/andcli/commands/pages are ignoredDoes this introduce a breaking change?
Other information
package.jsonoverrides@typescript-eslint/utilsto v8 for@docusaurus/eslint-plugin. The plugin's 3.x release depends on utils 5, which only accepts ESLint 6 to 8, so npm refuses to install it with ESLint 10. Docusaurus v4 already depends on utils 8, so remove the override when upgrading to Docusaurus v4.eslint-plugin-mdxneeds newer patch and minor versions of 8 shared MDX packages, includingremark-mdx3.0.0 to 3.1.1, which the site's MDX compile also uses. A build ofmainand of this branch produced identical HTML for all 2,248 pages.